Lender Price API Web Service
Lender Price API Web Service / ResultRates Json Schema
In This Topic
    ResultRates Json Schema
    In This Topic
    Overview
    ResultRates
    allowModifiedDate : boolean
    dayLocksList : Array[number]
    Array of allowable lock terms, in days.
    dayLock : number

    The length of a lock, in days.

    Default is 30.

    rateSet : Array[number]

    The set of rates that the pricing search has returned. All of the rates listed here will contain line results (individual loan results).

    Example:

    "rateSet": [

      2.5,

      2.55,

      2.65,

      2.75

    ]

    monthlyPaymentByRate : Array{key:value}

    An array of key:value pairs listing monthly payments by rate. The rate is listed as a string, and the monthly payment is listed as a double.

     

    Example:

    "monthlyPaymentByRate": {

      "2.25": 1500.00,

      "2.5": 1580.00,

      "2.65": 1600.00

    }

    data : data
    dti : number

    Debt-to-income ratio.

    Example:

    "dti": 0.769804

    hti : number

    House-to-income ratio, or housing ratio.

    Example:

    "hti": 0.324579

    mortgageType : String

    The mortgage type searched for.

    Example:

    "mortgageType": "Conventional"

    loanPurpose : String

    The loan purpose, as specified in the search query.

    Example:

    "loanPurpose": "Purchase"

     

    loanAmount : number

    The amount of the loan.

    Example:

    "loanAmount": 400000

     

    term : number

    The loan term, in years. The default is 30.

    Example:

    "term": 30

     

    dayLock : number

    The number of days that the loan can be locked for. Default is 30.

    Example:

    "dayLock": 30

     

    baseRates : Array[String]

    An array of the base rates.

    Example:

    "baseRates": 2.25

     

    adjustedRates : Array[String]

    An array of the adjusted rates in the result.

    Example:

    "adjustedRates": 2.25

     

    adjustmentRates : Array[String]

    An array of the applicable adjustment rates.

    Example:

    "adjustmentRates": 0

     

    loanLimitLite : LoanLimitLite
    conventionnalLoanLimitAmount : number
    countyLoanLimit1Unit : number
    countyLoanLimit2Unit : number
    countyLoanLimit3Unit : number
    countyLoanLimit4Unit : number
    fhaLoanLimit : number
    matchingCountyLoanLimit : number
    mortgageLimit : string
    mortgageLimitFHA : string
    monthlyPayments : Array[]
    monthlyPayment : MonthlyPayment
    buyDown : number
    buyDownRate : number
    end : integer
    homeOwnerInsurance : number
    mi : number
    monthlyPI : number
    otherExpenses : number
    propertyTaxes : number
    rate : number
    rent : number
    rentalPropertyCashFlowAmount : number
    start : integer
    total : number
    totalBuyDown : number
    totalInterest : number
    totalPrincipal : number
    multiSearchKey : number

    Example:

    "multiSearchKey": 2354789

    multiSearchKeyV2 : String

    Example:

    "multiSearchKeyV2": "40000_2398579"

    modLtv : number
    modFico : number
    basePoints : number

    Example:

    "basePoints": 2.816

    adjustedPoints : number

    Example:

    "adjustedPoints": 2.818

    adjustedPointsBorrowerPaid : number
    adjustmentPoints : number
    adjustmentPointsBorrowerPaid : number
    rawAdjustmentPoints : number
    rawAdjustmentPointsBorrowerPaid : number
    armIndexRate : number

    Example:

    "armIndexRate": 0

    notRoundedAPR : number

    Example:

    "notRoundedAPR": 2.166

    borrowerPaid : number

    The loan amount paid by the borrower.

    Example:

    "borrowerPaid": 11270

    borrowerPaidDetails : BorrowerPaidDetails
    lenderPaid : number

    Loan amount paid by the lender.

    Example:

    "lenderPaid": 11270

     

    lenderPaidDetails : LenderPaidDetails
    brokerPaidDetails : Array[]
    otherPaidDetails : Array[]
    hideDisqualified : Boolean
    Indicates whether disqualified loans are hidden.
    disqualified : Boolean
    Indicates whether this result is disqualified.
    interpolated : Boolean
    Indicates whether this result is an interpolated rate.
    interpolationTarget : Boolean
    groupAdjustmentPropertiesBorrowerPaid : GroupAdjustmentProperty
    adjustments : Array[Adj]
    adj : number
    The adjustment number.
    adjGroupCode : string
    adjType : string
    The adjustment type.
    attributes : Array[AdjAttribute]
    key : string
    value : string
    code : string
    compPlan : number
    The comp plan. Same value as in the criteria.compPlan field.
    disqualified : boolean
    forceAdjToHoldback : boolean
    includeInInterpolationComp : boolean
    key : string
    Adjustment key.
    llpa : number
    margin : number
    msr : number
    pmiTypes : Array[string]
    productCodes : Array[string]
    qualifiedSpecialOptionFromAdj : Array[SpecialMortgageOption]
    category : string
    The category of the special mortgage option.
    description : string
    Description of the mortgage option.
    dynamicProperties : object
    enabled : boolean
    Set to True if enabled.
    id : ObjectId
    The mortgage option ID, used for reference. 
    counter : integer
    internal only
    date : string

    The current date.

    internal only

    machineIdentifier : integer
    internal only
    processIdentifier : integer
    internal only
    time : integer
    internal only
    timeSecond : integer
    internal only
    timestamp : integer
    internal only
    name : string
    Name of the special mortgage option.
    qualifiedSpecialOptionFromAdjFilter : Array[SpecialMortgageOption]
    referenceId : string
    The reference ID for the adjustment.
    tags : Array[string]
    targetType : string
    triggerServicingGrouping : boolean
    type : string
    userGroupExternalId : string
    valueType : string
    armMargin : boolean
    cap : Cap
    disqualifyAdjustments : Array[string]
    finalAdjustment : number
    hideDisqualifyAdjustments : Array[string]
    includeZeroValuedAdjustments : boolean
    name : string
    pointBase : boolean
    qualifyAdjustments : Array[string]
    referenceId : string
    totalAdjustment : number
    type : string
    groupAdjustmentProperties : GroupAdjustmentProperty
    groupRateAdjustmentProperties : Array[]
    groupAdjustmentPropertiesBPMI : Array[]
    pointCap : Array[]
    holdBackResult : HoldBackResult
    broker : RateAdjustmentResult
    lender : RateAdjustmentResult
    totalAdjustment : number
    totalNoteRateAdjustment : number
    apr : number

    The APR rate.

    Example:

    "apr": 2.4655

    closingCost : ClosingCost
    allowErnstQuote : boolean
    Appears in line result. This value is set to True if Ernst quote is allowed.
    closingCostGroup : Array[ClosingCostGroup]
    Contains an array of ClosingCostGroup objects with data for closing cost groups associated with the loan.
    aprRelated : boolean

    True if the closing cost is APR related.

     

    closingCostItems : Array[ClosingCostItems]
    An array of ClosingCostItems objects containing closing cost item data.
    amount : number
    amountScript : string
    aprRelated : boolean
    automaticallyCalculated : boolean
    callForQuote : boolean
    convertedFromPercenetage : boolean
    ernstType : string
    escrowWaiver : boolean
    evalType : string
    includeInQmCriteria : boolean
    itemType : string
    items : Array[ClosingCostItem]
    amount : number
    amountScript : string
    aprRelated : boolean
    automaticallyCalculated : boolean
    callForQuote : boolean
    convertedFromPercenetage : boolean
    ernstType : string
    escrowWaiver : boolean
    evalType : string
    includeInQmCriteria : boolean
    itemType : string
    label : string
    name : string
    notes : Array[string]
    numberOfDaysForPrepaidInterest : integer
    numberOfPayments : integer
    percentPaidByBorrower : number
    percentageOfLoanAmount : number
    thirdPartyVendor : boolean
    totalBorrower : number
    totalBorrowerAprRelated : number
    totalBroker : number
    vendorName : string
    label : string
    name : string
    notes : Array[string]
    numberOfDaysForPrepaidInterest : integer
    numberOfPayments : integer
    percentPaidByBorrower : number
    percentageOfLoanAmount : number
    thirdPartyVendor : boolean
    totalBorrower : number
    totalBorrowerAprRelated : number
    totalBroker : number
    vendorName : string
    customFeeGroup : Array[string]
    A string array of custom fee groups.
    customTables : Array[ClosingCostCustomTable]
    An array of ClosingCostCustomTable objects storing custom closing cost tables.
    ausTypes : Array[string]
    columnItems : Array[ColumnCostItem]
    applyTax : boolean
    aprRelated : boolean
    asPercentage : boolean
    description : string
    idx : integer
    includeInQmCriteria : boolean
    label : string
    enable : boolean
    includeInSearch : boolean
    label : string
    loanAmountRange : Array[DoubleRangeLeGt]
    from : number
    null : boolean
    to : number
    loanPurposes : Array[string]
    loanTypes : Array[string]
    loanYears : Array[integer]
    mortgageTypes : Array[string]
    name : string
    propertyTypes : Array[string]
    propertyUses : Array[string]
    rawData : Array[HashMap]
    states : Array[string]
    tax : number
    termsInMonths : boolean
    values : Array[array]
    variableLoanTypes : Array[string]
    display : boolean
    Set
    fromErnstCost : boolean
    True if the closing cost group is from Ernst cost.
    groupType : string

    Specifies the group type of the closing cost group.

     

    id : ObjectId
    The closing cost group ID, stored in the ObjectId object along with internal metadata.
    name : string

    The name of the closing cost group.

     

     

    required : boolean
    True if this closing cost group is required in the closing cost calculation.
    total : number
    Total value of the closing cost group.
    directCustomFee : boolean
    settlementCost : SettlementCost
    Contains an array of SettlementCost objects with data on settlement costs associated with the loan.
    closingCostGroup : Array[ClosingCostGroup]
    closingCostGroup contains an array of ClosingCostGroup objects, each storing data on a closing cost group.
    origination : Origination
    Data on settlement cost origination, stored in the Origination object.
    administration : number
    administrationLabel : string
    lenderCredit : number
    lenderCreditLabel : string
    others : number
    othersLabel : string
    total : number
    underwriting : number
    underwritingLabel : string
    thirdPartyServices : ThirdPartyServices
    Data on third party services, stored in the ThirdPartyServices object.
    appraisal : number
    appraisalLabel : string
    creditReport : number
    creditReportLabel : string
    floodCertification : number
    floodCertificationLabel : string
    overnight : number
    overnightLabel : string
    recording : number
    recordingLabel : string
    taxService : number
    taxServiceLabel : string
    total : number
    titleService : TitleService
    Information on the title service of the settlement cost, stored in the TitleService object.
    total : number
    The settlement cost total amount.
    total : number

    Total closing cost value.

    Example:

    "total": 758
    useClosingCost : boolean
    True if calculated closing cost will be used.
    useCompanyDefaultClosingCost : boolean
    True if company default closing cost will be used.
    useErnstCost : boolean
    True if Ernst cost will be used.
    closingCostDetails : Array[]
    finalClosingCost : number

    Example:

    "finalClosingCost": 11250

    closingCostDetailsBorrowerPaid : Array[]
    finalClosingCostBorrowerPaid : number

    Example:

    "finalClosingCostBorrowerPaid": 11250

    compliancesMapByType : Array[]
    pmiType : String

    Example:

    "pmiType": "None"

    ratePeriod : RatePeriodLite
    applyParRounding : boolean
    autoImportClz : string
    classType : string
    company : NmlsCompanyLite
    createdFromCompanyId : ObjectId
    createdFromCompanyName : string
    createdFromRatePeriodId : ObjectId
    createdFromRatePeriodValidAs : string
    customDisplayLenderName : string
    defaultAdminFee : number
    end : string
    expired : boolean
    fees : Array[Fee]
    ficoModifierCapRange : IntegerRangeLeGe
    fileKeyForAutoImport : string
    limitCode : string
    loanLimitYearOverride : integer
    lockStatusPolicyId : string
    ltvModifierCapRange : DoubleRangeGeLe
    from : number
    The minimum value for the range.
    to : number
    The maximum value for the range.
    maxCompensation : number
    name : string
    originalRatePeriodId : string
    overrideHoldBack : number
    parentRateOrCompanyInvalid : boolean
    public : boolean
    publish : boolean
    rateType : string
    showCompanyName : boolean
    skipConstructionPeriod : boolean
    useInvestorLockPolicy : boolean
    validAsOf : string
    rateProgram : RateProgramLite
    applyParRounding : boolean
    code : string
    externalName : string
    lockGroup : string
    name : string
    rateGrid : RateGridLite
    adjMeta : Array[AdjMeta]
    adjType : string
    code : string
    key : string
    type : string
    value : number
    valueType : string
    adjustmentCap : number
    affordableHousingTypes : Array[string]
    agency : string
    allowedLockGroupChange : Array[string]
    amortizationTerms : integer
    armCaps : string
    armCeiling : number
    armChangeDates : Array[integer]
    armFloorRateFlatValue : number
    armFloorRateType : string
    armLookbackPeriod : integer
    armMargin : number
    armRoundingFactor : string
    armRoundingStractegy : string
    assumption : boolean
    aus : Array[string]
    closingDays : Array[integer]
    compPlan : number
    customFieldMap : object
    deactivateMi : boolean
    displayName : string
    disqualified : Array[string]
    disregardFhaLoanLimit : boolean
    dueTerms : integer
    fhaLoanType : string
    fhaMortgageLimitToMatch : number
    ficoModifierCapRange : IntegerRangeLeGe
    fixPaymentOption : string
    hedgeEnabled : boolean
    interestOnlyMonth : integer
    libor : string
    liborMigratedtoLiborType : boolean
    liborType : string
    listOfRateGridSelectedForBlendingWithInfo : object
    loanPlanId : string
    loanPurposes : Array[string]
    loanType : string
    lockGroup : string
    ltvModifierCapRange : DoubleRangeGeLe
    maxCompensation : number
    maxCompensationDollarAmount : number
    minimumMonthlyPaymentAmount : number
    minimumMonthlyPaymentPercentage : number
    mortgageLimitYearMatched : integer
    mortgageLimits : Array[string]
    mortgageLimitsMatchedWithSearch : Array[string]
    mortgageTypes : Array[string]
    name : string
    note : string
    parallelIO : boolean
    pmiTypes : Array[string]
    productCode : string
    qmTypes : Array[string]
    qualifyingRateSource : string
    specialMortgageOptions : Array[SpecialMortgageOption]
    specialtyProduct : string
    terms : Array[integer]
    termsInMonths : boolean
    vaLoanType : string
    varaiableLoanTypes : Array[string]
    yearlyTerm : number
    conditionActions : Array[ConditionAction]
    description : string
    documentUploaded : Array[ObjectId]
    counter : integer
    internal only
    date : string

    The current date.

    internal only

    machineIdentifier : integer
    internal only
    processIdentifier : integer
    internal only
    time : integer
    internal only
    timeSecond : integer
    internal only
    timestamp : integer
    internal only
    documentVerified : Array[ObjectId]
    name : string
    status : string
    type : string
    programName : String

    The program name of the result.

    Example:

    "programName": "30 Year Fixed"

     

    expired : Boolean
    Indicates whether the loan is expired.
    productName : String

    The name of the loan.

    Example:

    "productName": "30 Year Fixed"

     

    appraisalWaiverIndicator : Boolean
    highBalanceIndicator : Boolean
    borrowerPaidPoints : number

    Amount paid by the borrower, in points.

    Example:

    "borrowerPaidPoints": 2.800

    borrowerPaidAmount : number

    The amount paid by the borrower, in USD.

    Example:

    "borrowerPaidAmount": 11270

     

    sameServiceIndicator : Boolean
    apor : number

    Example:

    "apor": 0

    indexRate : number

    Example:

    "indexRate": 0

    loanFeePercent : Array[]
    loanFeeAmount : Array[]
    amortizationSchedule : Array[]
    annualMiPremiumAmount : number
    monthlyPaymentAmount : number
    monthlyTotal : number

    The total amount owed each month.

    Example:

    "monthlyTotal": 1180.00

     

    interestOnlyAmount : number

    Example:

    "interestOnlyAmount": 750

    interestPlusFixedPrinciple : number

    Example:

    "interestPlusFixedPrinciple": -24.999

    totalLoanAmount : number
    undiscountedInterestRatePercent : number
    bonafideAmount : number
    adjustedPricingExceptionAmount : number
    adjustedLockExtensionAmount : number
    cashToCloseAmount : number
    cashToCloseItems : Array[]
    qualifyingRatePercent : number

    Example:

    "quaifyingRatePercent": 2.25

    athenaFees : Array[]
    discountStartedAdjustedRate : number
    companyName : String

    Name of the company offering the loan.

    Example:

    "companyName": "Bank Name"

     

    totalGroupAdjustmentPropertiesByAdjType : Array[]
    totalGroupRateAdjustmentPropertiesByAdjType : Array[]
    discountDetail : DiscountDetail
    discountAmount : number
    discountRate : number
    premiumDetail : PremiumDetail
    premiumAmount : number
    premiumRate : number
    lenderFeeWaiver : Boolean
    Indicates whether the lender fee is waived.
    totalGroupAdjustmentPropertiesBorrowerPaid : number

    Example:

    "totalGroupAdjustmentPropertiesBorrowerPaid": 0.002000000000450

    totalGroupAdjustmentProperties : number

    Example:

    "totalGroupAdjustmentProperties": 0.002000000000450

    totalGroupAdjustmentRateProperties : number

    Example:

    "totalGroupAdjustmentRateProperties": 0

    mortgageLimitsMatchedWithSearch : Array[String]

    Example:

    "mortgageLimitsMatchedWithSearch": [

      "Conforming"

    ]

    Properties
    NameDescriptionData Type
     boolean
    Array of allowable lock terms, in days.Array[number]

    The length of a lock, in days.

    Default is 30.

    number

    The set of rates that the pricing search has returned. All of the rates listed here will contain line results (individual loan results).

    Example:

    "rateSet": [

      2.5,

      2.55,

      2.65,

      2.75

    ]

    Array[number]

    An array of key:value pairs listing monthly payments by rate. The rate is listed as a string, and the monthly payment is listed as a double.

     

    Example:

    "monthlyPaymentByRate": {

      "2.25": 1500.00,

      "2.5": 1580.00,

      "2.65": 1600.00

    }

    Array{key:value}
     data
    See Also